<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>esapi</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Package&nbsp;esapi
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="esapi-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
<h1 class="epydoc">Package esapi</h1><p class="nomargin-top"><span class="codelink"><a href="esapi-pysrc.html">source&nbsp;code</a></span></p>
<!-- ==================== SUBMODULES ==================== -->
<a name="section-Submodules"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Submodules</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Submodules"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr><td class="summary">
  <ul class="nomargin">
    <li> <strong class="uidlink"><a href="esapi.access_controller-module.html">esapi.access_controller</a></strong>: <em class="summary">The AccessController interface defines a set of methods that can be
        used in a wide variety of applications to enforce access control.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.access_reference_map-module.html">esapi.access_reference_map</a></strong>: <em class="summary">The AccessReferenceMap interface is used to map from a set of 
        internal direct object references to a set of indirect references 
        that are safe to disclose publicly.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.authenticator-module.html">esapi.authenticator</a></strong>: <em class="summary">The Authenticator interface defines a set of methods for generating
        and handling account credentials and session identifiers.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs-module.html">esapi.codecs</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="esapi.codecs.codec-module.html">esapi.codecs.codec</a></strong>: <em class="summary">The Codec interface defines a set of methods for encoding and 
        decoding application level encoding schemes.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.css-module.html">esapi.codecs.css</a></strong>: <em class="summary">Implementation of the codec.Codec interface for backslash encoding 
        used in CSS.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.html_entity-module.html">esapi.codecs.html_entity</a></strong>: <em class="summary">Implementation of the Codec interface for HTML entity encoding.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.javascript-module.html">esapi.codecs.javascript</a></strong>: <em class="summary">Implementation of the codec.Codec interface for backslash encoding 
        in JavaScript.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.ldap-module.html">esapi.codecs.ldap</a></strong>: <em class="summary">Implementation of the Codec interface for LDAP encoding.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.ldap_dn-module.html">esapi.codecs.ldap_dn</a></strong>: <em class="summary">Implementation of the Codec interface for LDAP distinguished name 
        encoding.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.mysql-module.html">esapi.codecs.mysql</a></strong>: <em class="summary">Implementation of the Codec interface for MySQL strings.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.oracle-module.html">esapi.codecs.oracle</a></strong>: <em class="summary">Implementation of the Codec interface for Oracle strings.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.percent-module.html">esapi.codecs.percent</a></strong>: <em class="summary">Implementation of the Codec interface for percent encoding (aka URL
        encoding)</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.push_back_string-module.html">esapi.codecs.push_back_string</a></strong>: <em class="summary">A PushbackString is used by Codecs to allow them to push decoded 
        characters back onto a string for further decoding.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.unix-module.html">esapi.codecs.unix</a></strong>: <em class="summary">Implementation of the Codec interface for backslash encoding from 
        Unix command shell.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.vbscript-module.html">esapi.codecs.vbscript</a></strong>: <em class="summary">The Encryptor interface provides a set of methods for performing 
        common encryption and hashing operations.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.codecs.windows-module.html">esapi.codecs.windows</a></strong>: <em class="summary">Implementation of the Codec interface for '^' encoding from Windows
        command shell.</em>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="esapi.conf-module.html">esapi.conf</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="esapi.conf.constants-module.html">esapi.conf.constants</a></strong>    </li>
    <li> <strong class="uidlink"><a href="esapi.conf.resources-module.html">esapi.conf.resources</a></strong>    </li>
    <li> <strong class="uidlink"><a href="esapi.conf.settings-module.html">esapi.conf.settings</a></strong>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="esapi.core-module.html">esapi.core</a></strong>: <em class="summary">ESAPI locator class is provided to make it easy to gain access to 
        the current ESAPI classes in use.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.encoder-module.html">esapi.encoder</a></strong>: <em class="summary">The Encoder interface contains a number of methods for decoding 
        input and encoding output so that it will be safe for a variety of 
        interpreters.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.encryptor-module.html">esapi.encryptor</a></strong>: <em class="summary">The Encryptor interface provides a set of methods for performing 
        common encryption and hashing operations.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.exceptions-module.html">esapi.exceptions</a></strong>: <em class="summary">All the exceptions used by ESAPI.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.executor-module.html">esapi.executor</a></strong>: <em class="summary">The Executor interface is used to run an OS command with reduced 
        security risk.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.http_utilities-module.html">esapi.http_utilities</a></strong>: <em class="summary">The HTTPUtilities interface is a collection of methods that provide
        additional security related to HTTP requests, responses, sessions, 
        cookies, headers, and logging.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.ihttp-module.html">esapi.ihttp</a></strong>: <em class="summary">A set of interfaces for HTTP requests, responses, and sessions.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.intrusion_detector-module.html">esapi.intrusion_detector</a></strong>: <em class="summary">The IntrusionDetector interface is intended to track security 
        relevant events and identify attack behavior.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.log_factory-module.html">esapi.log_factory</a></strong>: <em class="summary">The LogFactory interface is intended to allow substitution of 
        various logging packages, while providing a common interface to 
        access them.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.logger-module.html">esapi.logger</a></strong>: <em class="summary">The Logger interface defines a set of methods that can be used to 
        log security events.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.randomizer-module.html">esapi.randomizer</a></strong>: <em class="summary">The Randomizer interface defines a set of methods for creating 
        cryptographically random numbers and strings.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference-module.html">esapi.reference</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="esapi.reference.default_encoder-module.html">esapi.reference.default_encoder</a></strong>: <em class="summary">Reference implementation of the Encoder interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.default_encryptor-module.html">esapi.reference.default_encryptor</a></strong>: <em class="summary">Default implementation of the Encryptor interface using Google's 
        Keyczar.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.default_executor-module.html">esapi.reference.default_executor</a></strong>: <em class="summary">The default implementation of the Executor interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.default_http_utilities-module.html">esapi.reference.default_http_utilities</a></strong>: <em class="summary">Reference implementation of HTTPUtilities interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.default_intrusion_detector-module.html">esapi.reference.default_intrusion_detector</a></strong>: <em class="summary">Reference implementation of the IntrusionDetector interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.default_randomizer-module.html">esapi.reference.default_randomizer</a></strong>: <em class="summary">Reference implementation of the Randomizer interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.default_security_configuration-module.html">esapi.reference.default_security_configuration</a></strong>: <em class="summary">Reference implementation of the SecurityConfiguration interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.default_user-module.html">esapi.reference.default_user</a></strong>: <em class="summary">The User interface represents an application user or user account.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.default_validator-module.html">esapi.reference.default_validator</a></strong>: <em class="summary">Reference implementation of the Validator interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.file_based_access_controller-module.html">esapi.reference.file_based_access_controller</a></strong>: <em class="summary">Reference implementation of the AccessController interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.python_log_factory-module.html">esapi.reference.python_log_factory</a></strong>: <em class="summary">Reference implementation of the LogFactory and Logger interfaces.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.random_access_reference_map-module.html">esapi.reference.random_access_reference_map</a></strong>: <em class="summary">&nbsp;</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.shelve_authenticator-module.html">esapi.reference.shelve_authenticator</a></strong>: <em class="summary">A reference implementation</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.user_credentials-module.html">esapi.reference.user_credentials</a></strong>: <em class="summary">The UserCredentials class holds the credentials used to 
        authenticate a User.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.validation-module.html">esapi.reference.validation</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="esapi.reference.validation.base_validation_rule-module.html">esapi.reference.validation.base_validation_rule</a></strong>: <em class="summary">A BaseValidationRule performs syntax and possibly semantic 
        validation of a single piece of data from an untrusted source.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.validation.credit_card_validation_rule-module.html">esapi.reference.validation.credit_card_validation_rule</a></strong>: <em class="summary">Syntax and semantic validation of a credit card number.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.validation.date_validation_rule-module.html">esapi.reference.validation.date_validation_rule</a></strong>: <em class="summary">A ValidationRule for dates.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.validation.html_validation_rule-module.html">esapi.reference.validation.html_validation_rule</a></strong>: <em class="summary">An HTML validator using OWASP's AntiSamy.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.validation.number_validation_rule-module.html">esapi.reference.validation.number_validation_rule</a></strong>: <em class="summary">A ValidationRule to validate numbers.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.reference.validation.string_validation_rule-module.html">esapi.reference.validation.string_validation_rule</a></strong>: <em class="summary">A ValidationRule for strings.</em>    </li>
    </ul>
    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="esapi.security_configuration-module.html">esapi.security_configuration</a></strong>: <em class="summary">The SecurityConfiguration interface stores all configuration 
        information that directs the behavior of the ESAPI implementation.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test-module.html">esapi.test</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="esapi.test.conf-module.html">esapi.test.conf</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="esapi.test.conf.constants-module.html">esapi.test.conf.constants</a></strong>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.conf.resources-module.html">esapi.test.conf.resources</a></strong>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.conf.settings-module.html">esapi.test.conf.settings</a></strong>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="esapi.test.http-module.html">esapi.test.http</a></strong>
    <ul>
    <li> <strong class="uidlink"><a href="esapi.test.http.mock_http_request-module.html">esapi.test.http.mock_http_request</a></strong>: <em class="summary">A mock HTTP request used for testing.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.http.mock_http_response-module.html">esapi.test.http.mock_http_response</a></strong>: <em class="summary">A mock HTTP response used for testing.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.http.mock_session-module.html">esapi.test.http.mock_session</a></strong>: <em class="summary">A mock session used for testing.</em>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_access_controller-module.html">esapi.test.test_access_controller</a></strong>: <em class="summary">Test suite for AccessController interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_authenticator-module.html">esapi.test.test_authenticator</a></strong>: <em class="summary">Test suite for Authenticator interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_encoder-module.html">esapi.test.test_encoder</a></strong>: <em class="summary">Test suite for Encoder implementation.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_encryptor-module.html">esapi.test.test_encryptor</a></strong>: <em class="summary">Test suite for the Encryptor interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_executor-module.html">esapi.test.test_executor</a></strong>: <em class="summary">Test suite for Executor interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_http_utilities-module.html">esapi.test.test_http_utilities</a></strong>: <em class="summary">Test suite for the Logger interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_intrusion_detector-module.html">esapi.test.test_intrusion_detector</a></strong>: <em class="summary">Test suite for IntrusionDetector interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_logger-module.html">esapi.test.test_logger</a></strong>: <em class="summary">Test suite for the Logger interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_random_access_map-module.html">esapi.test.test_random_access_map</a></strong>: <em class="summary">Test suite for AccessReferenceMap interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_randomizer-module.html">esapi.test.test_randomizer</a></strong>: <em class="summary">Test suite for the Randomizer interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_user-module.html">esapi.test.test_user</a></strong>: <em class="summary">Test suite for User interface.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.test.test_validator-module.html">esapi.test.test_validator</a></strong>: <em class="summary">Test suite for Validator interface.</em>    </li>
    </ul>
    </li>
    <li> <strong class="uidlink"><a href="esapi.translation-module.html">esapi.translation</a></strong>: <em class="summary">Sets _ to the GNU gettext function for i18n.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.user-module.html">esapi.user</a></strong>: <em class="summary">The User interface represents an application user or user account.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.validation_error_list-module.html">esapi.validation_error_list</a></strong>: <em class="summary">The ValidationErrorList is a specialized dictionary to collect 
        ValidationExceptions.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.validation_rule-module.html">esapi.validation_rule</a></strong>: <em class="summary">The ValidationRule class is the parent class for the validators.</em>    </li>
    <li> <strong class="uidlink"><a href="esapi.validator-module.html">esapi.validator</a></strong>: <em class="summary">The Validator interface defines a set of methods for canonicalizing
        and validating untrusted input.</em>    </li>
  </ul></td></tr>
</table>

<br />
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code><br />
      hash(x)
    </td>
  </tr>
</table>
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th bgcolor="#70b0f0" class="navbar-select"
          >&nbsp;&nbsp;&nbsp;Home&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Nov  8 16:04:21 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
